docs: Add missing documentation for GtkTextCharPredicate
authorEmmanuele Bassi <ebassi@gnome.org>
Wed, 16 Dec 2020 15:16:51 +0000 (15:16 +0000)
committerEmmanuele Bassi <ebassi@gnome.org>
Wed, 16 Dec 2020 16:29:00 +0000 (16:29 +0000)
gtk/gtktextiter.h

index d47f0cfba216fe0cb3cfba6060cb8bae401f9641..c2ffd35c20ce4b9ad57060fc9ef63ac28763f5b0 100644 (file)
@@ -355,6 +355,17 @@ GDK_AVAILABLE_IN_ALL
 gboolean gtk_text_iter_backward_to_tag_toggle (GtkTextIter *iter,
                                                GtkTextTag  *tag);
 
+/**
+ * GtkTextCharPredicate:
+ * @ch: a Unicode code point
+ * @user_data: data passed to the callback
+ *
+ * The predicate function used by gtk_text_iter_forward_find_char() and
+ * gtk_text_iter_backward_find_char().
+ *
+ * Returns: %TRUE if the predicate is satisfied, and the iteration should
+ *   stop, and %FALSE otherwise
+ */
 typedef gboolean (* GtkTextCharPredicate) (gunichar ch, gpointer user_data);
 
 GDK_AVAILABLE_IN_ALL